<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit - Firmware API: usb_internal.h Source File</title>
<link href="mt_doxygen.css" rel="stylesheet" type="text/css" />
<link href="../resources/mt_doxytabs.css" rel="stylesheet" type="text/css" />
<style type="text/css">
<!--
.header {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 12pt;
	color: #222222;
}
-->
</style>
</head>

<body>
<table width="800" border="0">
    <tr>
      <td colspan="3">
        <form method="get" action="http://www.google.com/search">
          <div align="right">
            <input type="text"   name="q" size="25"
              maxlength="255" value="" />
            <input type="submit" value="Search" />
            <input type="hidden" name="sitesearch" value="makingthings.com/ref/firmware/html" />
          </div>
        </form>
       </td>
    </tr>
    <tr>
      <td><div align="center"><a href="http://www.makingthings.com">
				<img src="../resources/logo_brown_medium.png" alt="MakingThings"
									width="200" height="78" border="0" align="middle" longdesc="http://www.makingthings.com" /></a></div></td>
				<td><div align="center" class="header">
      		Make Controller Kit <br />
          Firmware API
      </div></td>
      <td><div align="center"><a href="http://www.makezine.com">
					<img src="../resources/make_logo.png" alt="MAKE Zine" 
										width="164" height="73" border="0" align="middle" longdesc="http://www.makezine.com" /></a></div></td>
    </tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.5.4 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
  var num=this.id.replace(/[^[0-9]/g,'');
  var button=this.firstChild;
  var sectionDiv=document.getElementById('dynsection'+num);
  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
    sectionDiv.style.display='block';
    button.src='open.gif';
  }else{
    sectionDiv.style.display='none';
    button.src='closed.gif';
  }
}
function initDynSections(){
  var divs=document.getElementsByTagName('div');
  var sectionCounter=1;
  for(var i=0;i<divs.length-1;i++){
    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
      var header=divs[i];
      var section=divs[i+1];
      var button=header.firstChild;
      if (button!='IMG'){
        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
        button=document.createElement('img');
        divs[i].insertBefore(button,divs[i].firstChild);
      }
      header.style.cursor='pointer';
      header.onclick=changeDisplayState;
      header.id='dynheader'+sectionCounter;
      button.src='closed.gif';
      section.id='dynsection'+sectionCounter;
      section.style.display='none';
      section.style.marginLeft='14px';
      sectionCounter++;
    }
  }
}
window.onload = initDynSections;
-->
</script>
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>usb_internal.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">  FreeRTOS V4.0.1 - copyright (C) 2003-2006 Richard Barry.</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">  This file is part of the FreeRTOS distribution.</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">  FreeRTOS is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment">  it under the terms of the GNU General Public License as published by</span>
<a name="l00008"></a>00008 <span class="comment">  the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00009"></a>00009 <span class="comment">  (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment">  FreeRTOS is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment">  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment">  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00014"></a>00014 <span class="comment">  GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">  You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment">  along with FreeRTOS; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment">  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">  A special exception to the GPL can be applied should you wish to distribute</span>
<a name="l00021"></a>00021 <span class="comment">  a combined work that includes FreeRTOS, without being obliged to provide</span>
<a name="l00022"></a>00022 <span class="comment">  the source code for any proprietary components.  See the licensing section</span>
<a name="l00023"></a>00023 <span class="comment">  of http://www.FreeRTOS.org for full details of how and when the exception</span>
<a name="l00024"></a>00024 <span class="comment">  can be applied.</span>
<a name="l00025"></a>00025 <span class="comment"></span>
<a name="l00026"></a>00026 <span class="comment">  ***************************************************************************</span>
<a name="l00027"></a>00027 <span class="comment">  See http://www.FreeRTOS.org for documentation, latest information, license</span>
<a name="l00028"></a>00028 <span class="comment">  and contact details.  Please ensure to read the configuration and relevant</span>
<a name="l00029"></a>00029 <span class="comment">  port sections of the online documentation.</span>
<a name="l00030"></a>00030 <span class="comment">  ***************************************************************************</span>
<a name="l00031"></a>00031 <span class="comment">*/</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="comment">/* Descriptor type definitions. */</span>
<a name="l00034"></a>00034 <span class="preprocessor">#define usbDESCRIPTOR_TYPE_DEVICE     ( 0x01 )</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#define usbDESCRIPTOR_TYPE_CONFIGURATION  ( 0x02 )</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define usbDESCRIPTOR_TYPE_STRING     ( 0x03 )</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span>
<a name="l00038"></a>00038 <span class="comment">/* USB request type definitions. */</span>
<a name="l00039"></a>00039 <span class="preprocessor">#define usbGET_REPORT_REQUEST       ( 0x01 )</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define usbGET_IDLE_REQUEST         ( 0x02 )</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define usbGET_PROTOCOL_REQUEST       ( 0x03 )</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define usbSET_REPORT_REQUEST       ( 0x09 )</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define usbSET_IDLE_REQUEST         ( 0x0A )</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define usbSET_PROTOCOL_REQUEST       ( 0x0B )</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#define usbGET_CONFIGURATION_REQUEST    ( 0x08 )</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#define usbGET_STATUS_REQUEST       ( 0x00 )</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#define usbCLEAR_FEATURE_REQUEST      ( 0x01 )</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#define usbSET_FEATURE_REQUEST        ( 0x03 )</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#define usbSET_ADDRESS_REQUEST        ( 0x05 )</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#define usbGET_DESCRIPTOR_REQUEST     ( 0x06 )</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">#define usbSET_CONFIGURATION_REQUEST    ( 0x09 )</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">#define usbGET_INTERFACE_REQUEST      ( 0x0A )</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#define usbSET_INTERFACE_REQUEST      ( 0x0B )</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span>
<a name="l00055"></a>00055 <span class="comment">/* ACM Requests */</span>
<a name="l00056"></a>00056 <span class="preprocessor">#define usbSEND_ENCAPSULATED_COMMAND    ( 0x00 )</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="preprocessor">#define usbGET_ENCAPSULATED_RESPONSE    ( 0x01 )</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor">#define usbSET_LINE_CODING          ( 0x20 )</span>
<a name="l00059"></a>00059 <span class="preprocessor"></span><span class="preprocessor">#define usbGET_LINE_CODING          ( 0x21 )</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor">#define usbSET_CONTROL_LINE_STATE     ( 0x22 )</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span>
<a name="l00062"></a>00062 <span class="comment">/* Misc USB definitions. */</span>
<a name="l00063"></a>00063 <span class="preprocessor">#define usbDEVICE_CLASS_VENDOR_SPECIFIC   ( 0xFF )</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor">#define usbBUS_POWERED            ( 0x80 )</span>
<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="preprocessor">#define usbHID_REPORT_DESCRIPTOR      ( 0x22 )</span>
<a name="l00066"></a>00066 <span class="preprocessor"></span><span class="preprocessor">#define AT91C_UDP_TRANSCEIVER_ENABLE    ( *( ( unsigned long * ) 0xfffb0074 ) )</span>
<a name="l00067"></a>00067 <span class="preprocessor"></span>
<a name="l00068"></a>00068 <span class="comment">/* Index to the various string. */</span>
<a name="l00069"></a>00069 <span class="preprocessor">#define usbLANGUAGE_STRING          ( 0 )</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span><span class="preprocessor">#define usbMANUFACTURER_STRING        ( 1 )</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span><span class="preprocessor">#define usbPRODUCT_STRING         ( 2 )</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span><span class="preprocessor">#define usbCONFIGURATION_STRING       ( 3 )</span>
<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="preprocessor">#define usbINTERFACE_STRING         ( 4 )</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span>
<a name="l00075"></a>00075 <span class="comment">/* Defines fields of standard SETUP request.  Now in normal order. */</span>
<a name="l00076"></a>00076 <span class="preprocessor">#define usbREQUEST_TYPE_INDEX       ( 0 )</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span><span class="preprocessor">#define usbREQUEST_INDEX          ( 1 )</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span><span class="preprocessor">#define usbVALUE_HIGH_BYTE          ( 3 )</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span><span class="preprocessor">#define usbVALUE_LOW_BYTE         ( 2 )</span>
<a name="l00080"></a>00080 <span class="preprocessor"></span><span class="preprocessor">#define usbINDEX_HIGH_BYTE          ( 5 )</span>
<a name="l00081"></a>00081 <span class="preprocessor"></span><span class="preprocessor">#define usbINDEX_LOW_BYTE         ( 4 )</span>
<a name="l00082"></a>00082 <span class="preprocessor"></span><span class="preprocessor">#define usbLENGTH_HIGH_BYTE         ( 7 )</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span><span class="preprocessor">#define usbLENGTH_LOW_BYTE          ( 6 )</span>
<a name="l00084"></a>00084 <span class="preprocessor"></span>
<a name="l00085"></a>00085 <span class="comment">/* Misc application definitions. */</span>
<a name="l00086"></a>00086 <span class="preprocessor">#define usbINTERRUPT_PRIORITY       ( 3 )</span>
<a name="l00087"></a>00087 <span class="preprocessor"></span><span class="preprocessor">#define usbQUEUE_LENGTH           ( 0x3 ) </span><span class="comment">/* Must have all bits set! */</span>
<a name="l00088"></a>00088 <span class="preprocessor">#define usbFIFO_LENGTH            ( ( unsigned portLONG ) 8 )</span>
<a name="l00089"></a>00089 <span class="preprocessor"></span><span class="preprocessor">#define usbEND_POINT_0            ( 0 )</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor">#define usbEND_POINT_1            ( 1 )</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span><span class="preprocessor">#define usbEND_POINT_2            ( 2 )</span>
<a name="l00092"></a>00092 <span class="preprocessor"></span><span class="preprocessor">#define usbEND_POINT_3            ( 3 )</span>
<a name="l00093"></a>00093 <span class="preprocessor"></span><span class="preprocessor">#define usbMAX_CONTROL_MESSAGE_SIZE     ( 128 )</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor">#define usbRX_COUNT_MASK          ( ( unsigned portLONG ) 0x7ff )</span>
<a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor">#define AT91C_UDP_STALLSENT         AT91C_UDP_ISOERROR</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span><span class="preprocessor">#define usbSHORTEST_DELAY         ( ( portTickType ) 1 )</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span><span class="preprocessor">#define usbINIT_DELAY           ( ( portTickType ) 1000 / portTICK_RATE_MS )</span>
<a name="l00098"></a>00098 <span class="preprocessor"></span><span class="preprocessor">#define usbSHORT_DELAY            ( ( portTickType ) 50 / portTICK_RATE_MS )</span>
<a name="l00099"></a>00099 <span class="preprocessor"></span><span class="preprocessor">#define usbEND_POINT_RESET_MASK       ( ( unsigned portLONG ) 0x0f )</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span><span class="preprocessor">#define usbDATA_INC             ( ( portCHAR ) 5 )</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span><span class="preprocessor">#define usbEXPECTED_NUMBER_OF_BYTES     ( ( unsigned portLONG ) 8 )</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span>
<a name="l00103"></a>00103 <span class="comment">/* Control request types. */</span>
<a name="l00104"></a>00104 <span class="preprocessor">#define usbSTANDARD_DEVICE_REQUEST      ( 0 )</span>
<a name="l00105"></a>00105 <span class="preprocessor"></span><span class="preprocessor">#define usbSTANDARD_INTERFACE_REQUEST   ( 1 )</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span><span class="preprocessor">#define usbSTANDARD_END_POINT_REQUEST   ( 2 )</span>
<a name="l00107"></a>00107 <span class="preprocessor"></span><span class="preprocessor">#define usbCLASS_INTERFACE_REQUEST      ( 5 )</span>
<a name="l00108"></a>00108 <span class="preprocessor"></span>
<a name="l00109"></a>00109 
<a name="l00110"></a>00110 <span class="comment">/* Macros to manipulate the control and status registers.  These registers </span>
<a name="l00111"></a>00111 <span class="comment">cannot be accessed using a direct read modify write operation outside of the </span>
<a name="l00112"></a>00112 <span class="comment">ISR as some bits are left unchanged by writing with a 0, and some are left </span>
<a name="l00113"></a>00113 <span class="comment">unchanged by writing with a 1. */</span>
<a name="l00114"></a>00114 
<a name="l00115"></a>00115 
<a name="l00116"></a>00116 <span class="preprocessor">#define usbCSR_SET_BIT( pulValueNow, ulBit )                      \</span>
<a name="l00117"></a>00117 <span class="preprocessor">{                                           \</span>
<a name="l00118"></a>00118 <span class="preprocessor">  </span><span class="comment">/* Set TXCOMP, RX_DATA_BK0, RXSETUP, */</span>                       \
<a name="l00119"></a>00119   <span class="comment">/* STALLSENT and RX_DATA_BK1 to 1 so the */</span>                     \
<a name="l00120"></a>00120   <span class="comment">/* write has no effect. */</span>                              \
<a name="l00121"></a>00121   ( * ( ( unsigned portLONG * ) pulValueNow ) ) |= ( unsigned portLONG ) 0x4f;    \
<a name="l00122"></a>00122                                             \
<a name="l00123"></a>00123   <span class="comment">/* Clear the FORCE_STALL and TXPKTRDY bits */</span>                   \
<a name="l00124"></a>00124   <span class="comment">/* so the write has no effect. */</span>                         \
<a name="l00125"></a>00125   ( * ( ( unsigned portLONG * ) pulValueNow ) ) &amp;= ( unsigned portLONG ) 0xffffffcf;  \
<a name="l00126"></a>00126                                             \
<a name="l00127"></a>00127   <span class="comment">/* Set whichever bit we want set. */</span>                        \
<a name="l00128"></a>00128   ( * ( ( unsigned portLONG * ) pulValueNow ) ) |= ( ulBit );             \
<a name="l00129"></a>00129 }
<a name="l00130"></a>00130 
<a name="l00131"></a>00131 <span class="preprocessor">#define usbCSR_CLEAR_BIT( pulValueNow, ulBit )                      \</span>
<a name="l00132"></a>00132 <span class="preprocessor">{                                           \</span>
<a name="l00133"></a>00133 <span class="preprocessor">  </span><span class="comment">/* Set TXCOMP, RX_DATA_BK0, RXSETUP, */</span>                       \
<a name="l00134"></a>00134   <span class="comment">/* STALLSENT and RX_DATA_BK1 to 1 so the */</span>                     \
<a name="l00135"></a>00135   <span class="comment">/* write has no effect. */</span>                              \
<a name="l00136"></a>00136   ( * ( ( unsigned portLONG * ) pulValueNow ) ) |= ( unsigned portLONG ) 0x4f;    \
<a name="l00137"></a>00137                                             \
<a name="l00138"></a>00138   <span class="comment">/* Clear the FORCE_STALL and TXPKTRDY bits */</span>                   \
<a name="l00139"></a>00139   <span class="comment">/* so the write has no effect. */</span>                         \
<a name="l00140"></a>00140   ( * ( ( unsigned portLONG * ) pulValueNow ) ) &amp;= ( unsigned portLONG ) 0xffffffcf;  \
<a name="l00141"></a>00141                                             \
<a name="l00142"></a>00142   <span class="comment">/* Clear whichever bit we want clear. */</span>                      \
<a name="l00143"></a>00143   ( * ( ( unsigned portLONG * ) pulValueNow ) ) &amp;= ( ~ulBit );            \
<a name="l00144"></a>00144 }
</pre></div><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit</title>
<style type="text/css">
<!--
.footer {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 9pt;
	color: #999999;
}
-->
</style>
</head>

<body>
<hr size="1">
<div>
  <p class="footer">The Make Controller Kit is an open source project maintained by <a href="http://www.makingthings.com">MakingThings</a>.<br />
    MakingThings code is released under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html" target="_blank">Apache 2.0 license</a>.<br />
    Bug tracker, development wiki and status can be found at <a href="http://dev.makingthings.com">http://dev.makingthings.com</a>.<br />
		This document was last updated on 5 Dec 2007.
</p>
</div>
<!-- Google Analytics Code -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-769030-1";
urchinTracker();
</script>
</body>
</html>
